AtomicX Core API/io.trtc.tuikit.atomicxcore.api.room

Package-level declarations

Types

CallRejectionReason

enum CallRejectionReason : Enum<CallRejectionReason>

Call rejection reason

CallUserToRoomCompletionHandler

interface CallUserToRoomCompletionHandler

Call user to room completion callback

CreateRoomOptions

data class CreateRoomOptions(var roomName: String = "", var password: String = "", var isAllMicrophoneDisabled: Boolean = false, var isAllCameraDisabled: Boolean = false, var isAllScreenShareDisabled: Boolean = false, var isAllMessageDisabled: Boolean = false)

Create room options

DeviceRequestInfo

data class DeviceRequestInfo(val timestamp: Long, val senderUserID: String, val senderUserName: String, val senderNameCard: String, val senderAvatarURL: String, val content: String, val device: DeviceType)

Device request info

GetRoomInfoCompletionHandler

interface GetRoomInfoCompletionHandler

Get room info completion callback

KickedOutOfRoomReason

enum KickedOutOfRoomReason : Enum<KickedOutOfRoomReason>

Reason for being kicked out of room

ParticipantRole

enum ParticipantRole : Enum<ParticipantRole>

Participant role

RoomCall

data class RoomCall(var caller: RoomUser = RoomUser(), var callee: RoomUser = RoomUser(), var status: RoomCallStatus = RoomCallStatus.NONE)

Room call info

RoomCallResult

enum RoomCallResult : Enum<RoomCallResult>

Call user to room result

RoomCallStatus

enum RoomCallStatus : Enum<RoomCallStatus>

Room call status

RoomInfo

data class RoomInfo(val roomID: String = "", val roomName: String = "", val roomOwner: RoomUser = RoomUser(), val participantCount: Int = 0, val createTime: Long = 0, var roomStatus: RoomStatus = RoomStatus.SCHEDULED, val scheduledStartTime: Long = 0, val scheduledEndTime: Long = 0, val startReminderInSeconds: Int = 0, val scheduleAttendees: List<RoomUser> = emptyList(), val password: String? = null, val isAllMicrophoneDisabled: Boolean = false, val isAllCameraDisabled: Boolean = false, val isAllMessageDisabled: Boolean = false, val isAllScreenShareDisabled: Boolean = false)

Room info

RoomListener

abstract class RoomListener

Room event callback

RoomParticipant

data class RoomParticipant(var userID: String = "", var userName: String = "", var avatarURL: String = "", var nameCard: String = "", var role: ParticipantRole = ParticipantRole.GENERAL_USER, var roomStatus: RoomParticipantStatus = RoomParticipantStatus.SCHEDULED, var microphoneStatus: DeviceStatus = DeviceStatus.OFF, var cameraStatus: DeviceStatus = DeviceStatus.OFF, var screenShareStatus: DeviceStatus = DeviceStatus.OFF, var isMessageDisabled: Boolean = false, var metaData: MutableMap<String, ByteArray> = mutableMapOf())

Room participant info

RoomParticipantListener

abstract class RoomParticipantListener

Participant event callback

RoomParticipantState

data class RoomParticipantState(val participantList: StateFlow<List<RoomParticipant>>, val participantListCursor: StateFlow<String>, val participantListWithVideo: StateFlow<List<RoomParticipant>>, val participantWithScreen: StateFlow<RoomParticipant?>, val pendingDeviceApplications: StateFlow<List<DeviceRequestInfo>>, val pendingDeviceInvitations: StateFlow<List<DeviceRequestInfo>>, val speakingUsers: StateFlow<MutableMap<String, Int>>, val networkQualities: StateFlow<MutableMap<String, NetworkInfo>>, val pendingParticipantList: StateFlow<List<RoomParticipant>>, val localParticipant: StateFlow<RoomParticipant?>)

Participant related state data provided by RoomParticipantStore

RoomParticipantStatus

enum RoomParticipantStatus : Enum<RoomParticipantStatus>

Participant status

RoomParticipantStore

abstract class RoomParticipantStore

Room participant management related interfaces, managing participant permissions, device control, message muting and other operations.

RoomState

data class RoomState(val scheduledRoomList: StateFlow<List<RoomInfo>>, val scheduledRoomListCursor: StateFlow<String>, val currentRoom: StateFlow<RoomInfo?>)

Room related state data provided by RoomStore

RoomStatus

enum RoomStatus : Enum<RoomStatus>

Room status

RoomStore

abstract class RoomStore

Room management related interfaces, managing room creation, joining, leaving, scheduling and other operations.

RoomUser

data class RoomUser(var userID: String = "", var userName: String = "", var avatarURL: String = "")

Room user info

ScheduleRoomOptions

data class ScheduleRoomOptions(var roomName: String = "", var password: String = "", var scheduleStartTime: Long = 0, var scheduleEndTime: Long = 0, var reminderSecondsBeforeStart: Int = 0, var scheduleAttendees: List<String> = emptyList(), var isAllMicrophoneDisabled: Boolean = false, var isAllCameraDisabled: Boolean = false, var isAllScreenShareDisabled: Boolean = false, var isAllMessageDisabled: Boolean = false)

Schedule room options

UpdateRoomOptions

data class UpdateRoomOptions(var roomName: String = "", var password: String = "")

Update room options